/****************************************************************************
 * Copyright 2009 Huascar A. Sanchez                                        *
 *                                                                          *
 * Licensed under the Apache License, Version 2.0 (the "License");          *
 * you may not use this file except in compliance with the License.         *
 * You may obtain a copy of the License at                                  *
 *                                                                          *
 *     http://www.apache.org/licenses/LICENSE-2.0                           *
 *                                                                          *
 * Unless required by applicable law or agreed to in writing, software      *
 * distributed under the License is distributed on an "AS IS" BASIS,        *
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
 * See the License for the specific language governing permissions and      *
 * limitations under the License.                                           *
 ****************************************************************************/
package com.gotobject.filter.spi;

import com.gotobject.filter.predicate.Predicate;

/**
 * @author huascar.sanchez@gmail.com (Huascar A. Sanchez)
 */
public interface Filtering <T> {
    /**
     * processes a data structure (typically a collection) in some order to
     * produce a new data structure containing exactly those elements of the original
     * data structure for which a given predicate returns {@code true}.
     *
     * @param predicate
     *      predicate which will be used to evaluate the members of a
     *      a data structure.
     * @param source
     *      original data structure.
     * @return
     *      the filtered data structure.
     */
    Iterable <T> filter(Predicate<? super T> predicate, Iterable<T> source);
}
